// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

// Code generated from the elasticsearch-specification DO NOT EDIT.
// https://github.com/elastic/elasticsearch-specification/tree/cbfcc73d01310bed2a480ec35aaef98138b598e5

package types

// RankEvalMetric type.
//
// https://github.com/elastic/elasticsearch-specification/blob/cbfcc73d01310bed2a480ec35aaef98138b598e5/specification/_global/rank_eval/types.ts#L90-L96
type RankEvalMetric struct {
	Dcg                    *RankEvalMetricDiscountedCumulativeGain `json:"dcg,omitempty"`
	ExpectedReciprocalRank *RankEvalMetricExpectedReciprocalRank   `json:"expected_reciprocal_rank,omitempty"`
	MeanReciprocalRank     *RankEvalMetricMeanReciprocalRank       `json:"mean_reciprocal_rank,omitempty"`
	Precision              *RankEvalMetricPrecision                `json:"precision,omitempty"`
	Recall                 *RankEvalMetricRecall                   `json:"recall,omitempty"`
}

// NewRankEvalMetric returns a RankEvalMetric.
func NewRankEvalMetric() *RankEvalMetric {
	r := &RankEvalMetric{}

	return r
}

// true

type RankEvalMetricVariant interface {
	RankEvalMetricCaster() *RankEvalMetric
}

func (s *RankEvalMetric) RankEvalMetricCaster() *RankEvalMetric {
	return s
}
